Document CI and pull request integration - #79
Conversation
|
Thanks for documenting the CI and pull-request workflow in both languages. I merged this head with the current
The package-freshness wording should also be narrowed. Documentation inside the packaged Small cleanup: |
|
Addressed the maintainer review comments in the latest commit. The updated PR description contains the exact verification commands and results. |
|
Thanks for addressing the previous review feedback. I rechecked the latest revision against the current main: the documented validate, deliver, and compare commands all run successfully, the English and Chinese links resolve, and the full suite passes 655/655 after a local merge. The documentation itself looks ready. The branch is currently four main-branch commits behind and GitHub reports no checks for this head. Please update the branch with the current main so the remote CI suite can run. If those checks are green, this should be ready to approve and merge without further documentation changes. |
|
Thank you again for the work you put into this PR, especially for patiently addressing the earlier review feedback. After taking another look at the use case, I don't think we should add a separate CI integration guide right now. The workflow here assumes that a repository already contains the full This is a product-scope decision rather than a problem with the care you put into the documentation, so I would rather close the PR than ask you to keep revising something we are not ready to support properly. If you are still interested in contributing, #95 would be a very welcome improvement. It focuses on making the English and Chinese READMEs easier for new users to understand by adding a scenario-first chooser, while keeping the current hero and visual introduction unchanged. You would be very welcome to work on that one. Thanks again for the contribution and for being responsive throughout the review. |
Problem and value
Archify already has stable JSON receipts and repository CI jobs, but contributors need a reusable example for validating diagrams, uploading receipts, producing trusted artifacts, and checking package freshness.
This PR documents those existing automation boundaries in English and Chinese and links the guide from the pull-request template.
Scope
docs/ci-integration.md.docs/ci-integration.zh-CN.md..github/PULL_REQUEST_TEMPLATE.md.archify.zipchanges.Non-goals
Tests run
node bin/archify.mjs doctor— passed.node bin/archify.mjs guide "Show an API request with a Redis cache miss" --json— passed.node bin/archify.mjs validate sequence examples/cache-miss-request.sequence.json --quality showcase --json— passed: 9/9 checks, 0 errors, 0 warnings.npm test— the repository suite reached two environment-specific failures on Windows: preview termination expects a clean SIGTERM exit, and the Cursor archive test requires the Unixunzipexecutable. The documentation-related checks passed.Generated artifacts
None. This PR changes documentation only;
archify.zipremains fresh.Visual evidence
Not applicable.
Review follow-up
Addressed all requested items:
Fresh verification: